home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 April: Mac OS SDK / Dev.CD Apr 97 SDK1.toast / Development Kits (Disc 1) / Interfaces&Libraries / Interfaces / PInterfaces / Speech.p < prev    next >
Encoding:
Text File  |  1995-07-06  |  11.2 KB  |  389 lines  |  [TEXT/MPS ]
  1. {
  2.      File:        Speech.p
  3.  
  4.      Contains:    Speech Interfaces.
  5.  
  6.      Version:    Technology:    System 7.5
  7.                  Package:    Universal Interfaces 2.1 in “MPW Latest” on ETO #18
  8.  
  9.      Copyright:    © 1984-1995 by Apple Computer, Inc.
  10.                  All rights reserved.
  11.  
  12.      Bugs?:        If you find a problem with this file, use the Apple Bug Reporter
  13.                  stack.  Include the file and version information (from above)
  14.                  in the problem description and send to:
  15.                      Internet:    apple.bugs@applelink.apple.com
  16.                      AppleLink:    APPLE.BUGS
  17.  
  18. }
  19.  
  20. {$IFC UNDEFINED UsingIncludes}
  21. {$SETC UsingIncludes := 0}
  22. {$ENDC}
  23.  
  24. {$IFC NOT UsingIncludes}
  25.  UNIT Speech;
  26.  INTERFACE
  27. {$ENDC}
  28.  
  29. {$IFC UNDEFINED __SPEECH__}
  30. {$SETC __SPEECH__ := 1}
  31.  
  32. {$I+}
  33. {$SETC SpeechIncludes := UsingIncludes}
  34. {$SETC UsingIncludes := 1}
  35.  
  36.  
  37. {$IFC UNDEFINED __TYPES__}
  38. {$I Types.p}
  39. {$ENDC}
  40. {    ConditionalMacros.p                                            }
  41.  
  42. {$IFC UNDEFINED __MEMORY__}
  43. {$I Memory.p}
  44. {$ENDC}
  45. {    MixedMode.p                                                    }
  46.  
  47. {$IFC UNDEFINED __FILES__}
  48. {$I Files.p}
  49. {$ENDC}
  50. {    OSUtils.p                                                    }
  51. {    Finder.p                                                    }
  52.  
  53. {$PUSH}
  54. {$ALIGN MAC68K}
  55. {$LibExport+}
  56.  
  57. CONST
  58.     kTextToSpeechSynthType        = 'ttsc';
  59.     kTextToSpeechVoiceType        = 'ttvd';
  60.     kTextToSpeechVoiceFileType    = 'ttvf';
  61.     kTextToSpeechVoiceBundleType = 'ttvb';
  62.  
  63.     kNoEndingProsody            = 1;
  64.     kNoSpeechInterrupt            = 2;
  65.     kPreflightThenPause            = 4;
  66.  
  67.     kImmediate                    = 0;
  68.     kEndOfWord                    = 1;
  69.     kEndOfSentence                = 2;
  70.  
  71. {------------------------------------------}
  72. { GetSpeechInfo & SetSpeechInfo selectors    }
  73. {------------------------------------------}
  74.     soStatus                    = 'stat';
  75.     soErrors                    = 'erro';
  76.     soInputMode                    = 'inpt';
  77.     soCharacterMode                = 'char';
  78.     soNumberMode                = 'nmbr';
  79.     soRate                        = 'rate';
  80.     soPitchBase                    = 'pbas';
  81.     soPitchMod                    = 'pmod';
  82.     soVolume                    = 'volm';
  83.     soSynthType                    = 'vers';
  84.     soRecentSync                = 'sync';
  85.     soPhonemeSymbols            = 'phsy';
  86.     soCurrentVoice                = 'cvox';
  87.     soCommandDelimiter            = 'dlim';
  88.     soReset                        = 'rset';
  89.     soCurrentA5                    = 'myA5';
  90.     soRefCon                    = 'refc';
  91.     soTextDoneCallBack            = 'tdcb';
  92.     soSpeechDoneCallBack        = 'sdcb';
  93.     soSyncCallBack                = 'sycb';
  94.     soErrorCallBack                = 'ercb';
  95.     soPhonemeCallBack            = 'phcb';
  96.     soWordCallBack                = 'wdcb';
  97.     soSynthExtension            = 'xtnd';
  98.     soSoundOutput                = 'sndo';
  99.  
  100. {------------------------------------------}
  101. { Speaking Mode Constants                     }
  102. {------------------------------------------}
  103.     modeText                    = 'TEXT';                        { input mode constants                     }
  104.     modePhonemes                = 'PHON';
  105.     modeNormal                    = 'NORM';                        { character mode and number mode constants }
  106.     modeLiteral                    = 'LTRL';
  107.  
  108.     soVoiceDescription            = 'info';
  109.     soVoiceFile                    = 'fref';
  110.  
  111.  
  112. TYPE
  113.     SpeechChannelRecord = RECORD
  114.         data:                    ARRAY [0..0] OF LONGINT;
  115.     END;
  116.  
  117.     SpeechChannel = ^SpeechChannelRecord;
  118.  
  119.     VoiceSpec = RECORD
  120.         creator:                OSType;
  121.         id:                        OSType;
  122.     END;
  123.  
  124.  
  125. CONST
  126.     kNeuter                        = 0;
  127.     kMale                        = 1;
  128.     kFemale                        = 2;
  129.  
  130.  
  131. TYPE
  132.     VoiceDescription = RECORD
  133.         length:                    LONGINT;
  134.         voice:                    VoiceSpec;
  135.         version:                LONGINT;
  136.         name:                    Str63;
  137.         comment:                Str255;
  138.         gender:                    INTEGER;
  139.         age:                    INTEGER;
  140.         script:                    INTEGER;
  141.         language:                INTEGER;
  142.         region:                    INTEGER;
  143.         reserved:                ARRAY [0..3] OF LONGINT;
  144.     END;
  145.  
  146.     VoiceFileInfo = RECORD
  147.         fileSpec:                FSSpec;
  148.         resID:                    INTEGER;
  149.     END;
  150.  
  151.     SpeechStatusInfo = RECORD
  152.         outputBusy:                BOOLEAN;
  153.         outputPaused:            BOOLEAN;
  154.         inputBytesLeft:            LONGINT;
  155.         phonemeCode:            INTEGER;
  156.     END;
  157.  
  158.     SpeechErrorInfo = RECORD
  159.         count:                    INTEGER;
  160.         oldest:                    OSErr;
  161.         oldPos:                    LONGINT;
  162.         newest:                    OSErr;
  163.         newPos:                    LONGINT;
  164.     END;
  165.  
  166.     SpeechVersionInfo = RECORD
  167.         synthType:                OSType;
  168.         synthSubType:            OSType;
  169.         synthManufacturer:        OSType;
  170.         synthFlags:                LONGINT;
  171.         synthVersion:            NumVersion;
  172.     END;
  173.  
  174.     PhonemeInfo = RECORD
  175.         opcode:                    INTEGER;
  176.         phStr:                    Str15;
  177.         exampleStr:                Str31;
  178.         hiliteStart:            INTEGER;
  179.         hiliteEnd:                INTEGER;
  180.     END;
  181.  
  182.     PhonemeDescriptor = RECORD
  183.         phonemeCount:            INTEGER;
  184.         thePhonemes:            ARRAY [0..0] OF PhonemeInfo;
  185.     END;
  186.  
  187.     SpeechXtndData = PACKED RECORD
  188.         synthCreator:            OSType;
  189.         synthData:                ARRAY [0..1] OF Byte;
  190.     END;
  191.  
  192.     DelimiterInfo = PACKED RECORD
  193.         startDelimiter:            ARRAY [0..1] OF Byte;
  194.         endDelimiter:            ARRAY [0..1] OF Byte;
  195.     END;
  196.  
  197.     SpeechTextDoneProcPtr = ProcPtr;  { PROCEDURE SpeechTextDone(parameter0: SpeechChannel; parameter1: LONGINT; VAR parameter2: Ptr; VAR parameter3: LONGINT; VAR parameter4: LONGINT); }
  198.     SpeechDoneProcPtr = ProcPtr;  { PROCEDURE SpeechDone(parameter0: SpeechChannel; parameter1: LONGINT); }
  199.     SpeechSyncProcPtr = ProcPtr;  { PROCEDURE SpeechSync(parameter0: SpeechChannel; parameter1: LONGINT; parameter2: OSType); }
  200.     SpeechErrorProcPtr = ProcPtr;  { PROCEDURE SpeechError(parameter0: SpeechChannel; parameter1: LONGINT; parameter2: OSErr; parameter3: LONGINT); }
  201.     SpeechPhonemeProcPtr = ProcPtr;  { PROCEDURE SpeechPhoneme(parameter0: SpeechChannel; parameter1: LONGINT; parameter2: INTEGER); }
  202.     SpeechWordProcPtr = ProcPtr;  { PROCEDURE SpeechWord(parameter0: SpeechChannel; parameter1: LONGINT; parameter2: LONGINT; parameter3: INTEGER); }
  203.     SpeechTextDoneUPP = UniversalProcPtr;
  204.     SpeechDoneUPP = UniversalProcPtr;
  205.     SpeechSyncUPP = UniversalProcPtr;
  206.     SpeechErrorUPP = UniversalProcPtr;
  207.     SpeechPhonemeUPP = UniversalProcPtr;
  208.     SpeechWordUPP = UniversalProcPtr;
  209.  
  210. CONST
  211.     uppSpeechTextDoneProcInfo = $0000FFC0; { PROCEDURE (4 byte param, 4 byte param, 4 byte param, 4 byte param, 4 byte param); }
  212.     uppSpeechDoneProcInfo = $000003C0; { PROCEDURE (4 byte param, 4 byte param); }
  213.     uppSpeechSyncProcInfo = $00000FC0; { PROCEDURE (4 byte param, 4 byte param, 4 byte param); }
  214.     uppSpeechErrorProcInfo = $00003BC0; { PROCEDURE (4 byte param, 4 byte param, 2 byte param, 4 byte param); }
  215.     uppSpeechPhonemeProcInfo = $00000BC0; { PROCEDURE (4 byte param, 4 byte param, 2 byte param); }
  216.     uppSpeechWordProcInfo = $00002FC0; { PROCEDURE (4 byte param, 4 byte param, 4 byte param, 2 byte param); }
  217.  
  218. FUNCTION NewSpeechTextDoneProc(userRoutine: SpeechTextDoneProcPtr): SpeechTextDoneUPP;
  219.     {$IFC NOT GENERATINGCFM }
  220.     INLINE $2E9F;
  221.     {$ENDC}
  222.  
  223. FUNCTION NewSpeechDoneProc(userRoutine: SpeechDoneProcPtr): SpeechDoneUPP;
  224.     {$IFC NOT GENERATINGCFM }
  225.     INLINE $2E9F;
  226.     {$ENDC}
  227.  
  228. FUNCTION NewSpeechSyncProc(userRoutine: SpeechSyncProcPtr): SpeechSyncUPP;
  229.     {$IFC NOT GENERATINGCFM }
  230.     INLINE $2E9F;
  231.     {$ENDC}
  232.  
  233. FUNCTION NewSpeechErrorProc(userRoutine: SpeechErrorProcPtr): SpeechErrorUPP;
  234.     {$IFC NOT GENERATINGCFM }
  235.     INLINE $2E9F;
  236.     {$ENDC}
  237.  
  238. FUNCTION NewSpeechPhonemeProc(userRoutine: SpeechPhonemeProcPtr): SpeechPhonemeUPP;
  239.     {$IFC NOT GENERATINGCFM }
  240.     INLINE $2E9F;
  241.     {$ENDC}
  242.  
  243. FUNCTION NewSpeechWordProc(userRoutine: SpeechWordProcPtr): SpeechWordUPP;
  244.     {$IFC NOT GENERATINGCFM }
  245.     INLINE $2E9F;
  246.     {$ENDC}
  247.  
  248. PROCEDURE CallSpeechTextDoneProc(parameter0: SpeechChannel; parameter1: LONGINT; VAR parameter2: Ptr; VAR parameter3: LONGINT; VAR parameter4: LONGINT; userRoutine: SpeechTextDoneUPP);
  249.     {$IFC NOT GENERATINGCFM}
  250.     INLINE $205F, $4E90;
  251.     {$ENDC}
  252.  
  253. PROCEDURE CallSpeechDoneProc(parameter0: SpeechChannel; parameter1: LONGINT; userRoutine: SpeechDoneUPP);
  254.     {$IFC NOT GENERATINGCFM}
  255.     INLINE $205F, $4E90;
  256.     {$ENDC}
  257.  
  258. PROCEDURE CallSpeechSyncProc(parameter0: SpeechChannel; parameter1: LONGINT; parameter2: OSType; userRoutine: SpeechSyncUPP);
  259.     {$IFC NOT GENERATINGCFM}
  260.     INLINE $205F, $4E90;
  261.     {$ENDC}
  262.  
  263. PROCEDURE CallSpeechErrorProc(parameter0: SpeechChannel; parameter1: LONGINT; parameter2: OSErr; parameter3: LONGINT; userRoutine: SpeechErrorUPP);
  264.     {$IFC NOT GENERATINGCFM}
  265.     INLINE $205F, $4E90;
  266.     {$ENDC}
  267.  
  268. PROCEDURE CallSpeechPhonemeProc(parameter0: SpeechChannel; parameter1: LONGINT; parameter2: INTEGER; userRoutine: SpeechPhonemeUPP);
  269.     {$IFC NOT GENERATINGCFM}
  270.     INLINE $205F, $4E90;
  271.     {$ENDC}
  272.  
  273. PROCEDURE CallSpeechWordProc(parameter0: SpeechChannel; parameter1: LONGINT; parameter2: LONGINT; parameter3: INTEGER; userRoutine: SpeechWordUPP);
  274.     {$IFC NOT GENERATINGCFM}
  275.     INLINE $205F, $4E90;
  276.     {$ENDC}
  277.  
  278. FUNCTION SpeechManagerVersion: NumVersion;
  279.     {$IFC NOT GENERATINGCFM}
  280.     INLINE $203C, $0000, $000C, $A800;
  281.     {$ENDC}
  282. FUNCTION MakeVoiceSpec(creator: OSType; id: OSType; VAR voice: VoiceSpec): OSErr;
  283.     {$IFC NOT GENERATINGCFM}
  284.     INLINE $203C, $0604, $000C, $A800;
  285.     {$ENDC}
  286. FUNCTION CountVoices(VAR numVoices: INTEGER): OSErr;
  287.     {$IFC NOT GENERATINGCFM}
  288.     INLINE $203C, $0108, $000C, $A800;
  289.     {$ENDC}
  290. FUNCTION GetIndVoice(index: INTEGER; VAR voice: VoiceSpec): OSErr;
  291.     {$IFC NOT GENERATINGCFM}
  292.     INLINE $203C, $030C, $000C, $A800;
  293.     {$ENDC}
  294. FUNCTION GetVoiceDescription(VAR voice: VoiceSpec; VAR info: VoiceDescription; infoLength: LONGINT): OSErr;
  295.     {$IFC NOT GENERATINGCFM}
  296.     INLINE $203C, $0610, $000C, $A800;
  297.     {$ENDC}
  298. FUNCTION GetVoiceInfo(VAR voice: VoiceSpec; selector: OSType; voiceInfo: UNIV Ptr): OSErr;
  299.     {$IFC NOT GENERATINGCFM}
  300.     INLINE $203C, $0614, $000C, $A800;
  301.     {$ENDC}
  302. FUNCTION NewSpeechChannel(VAR voice: VoiceSpec; VAR chan: SpeechChannel): OSErr;
  303.     {$IFC NOT GENERATINGCFM}
  304.     INLINE $203C, $0418, $000C, $A800;
  305.     {$ENDC}
  306. FUNCTION DisposeSpeechChannel(chan: SpeechChannel): OSErr;
  307.     {$IFC NOT GENERATINGCFM}
  308.     INLINE $203C, $021C, $000C, $A800;
  309.     {$ENDC}
  310. FUNCTION SpeakString(s: StringPtr): OSErr;
  311.     {$IFC NOT GENERATINGCFM}
  312.     INLINE $203C, $0220, $000C, $A800;
  313.     {$ENDC}
  314. FUNCTION SpeakText(chan: SpeechChannel; textBuf: Ptr; textBytes: LONGINT): OSErr;
  315.     {$IFC NOT GENERATINGCFM}
  316.     INLINE $203C, $0624, $000C, $A800;
  317.     {$ENDC}
  318. FUNCTION SpeakBuffer(chan: SpeechChannel; textBuf: Ptr; textBytes: LONGINT; controlFlags: LONGINT): OSErr;
  319.     {$IFC NOT GENERATINGCFM}
  320.     INLINE $203C, $0828, $000C, $A800;
  321.     {$ENDC}
  322. FUNCTION StopSpeech(chan: SpeechChannel): OSErr;
  323.     {$IFC NOT GENERATINGCFM}
  324.     INLINE $203C, $022C, $000C, $A800;
  325.     {$ENDC}
  326. FUNCTION StopSpeechAt(chan: SpeechChannel; whereToStop: LONGINT): OSErr;
  327.     {$IFC NOT GENERATINGCFM}
  328.     INLINE $203C, $0430, $000C, $A800;
  329.     {$ENDC}
  330. FUNCTION PauseSpeechAt(chan: SpeechChannel; whereToPause: LONGINT): OSErr;
  331.     {$IFC NOT GENERATINGCFM}
  332.     INLINE $203C, $0434, $000C, $A800;
  333.     {$ENDC}
  334. FUNCTION ContinueSpeech(chan: SpeechChannel): OSErr;
  335.     {$IFC NOT GENERATINGCFM}
  336.     INLINE $203C, $0238, $000C, $A800;
  337.     {$ENDC}
  338. FUNCTION SpeechBusy: INTEGER;
  339.     {$IFC NOT GENERATINGCFM}
  340.     INLINE $203C, $003C, $000C, $A800;
  341.     {$ENDC}
  342. FUNCTION SpeechBusySystemWide: INTEGER;
  343.     {$IFC NOT GENERATINGCFM}
  344.     INLINE $203C, $0040, $000C, $A800;
  345.     {$ENDC}
  346. FUNCTION SetSpeechRate(chan: SpeechChannel; rate: Fixed): OSErr;
  347.     {$IFC NOT GENERATINGCFM}
  348.     INLINE $203C, $0444, $000C, $A800;
  349.     {$ENDC}
  350. FUNCTION GetSpeechRate(chan: SpeechChannel; VAR rate: Fixed): OSErr;
  351.     {$IFC NOT GENERATINGCFM}
  352.     INLINE $203C, $0448, $000C, $A800;
  353.     {$ENDC}
  354. FUNCTION SetSpeechPitch(chan: SpeechChannel; pitch: Fixed): OSErr;
  355.     {$IFC NOT GENERATINGCFM}
  356.     INLINE $203C, $044C, $000C, $A800;
  357.     {$ENDC}
  358. FUNCTION GetSpeechPitch(chan: SpeechChannel; VAR pitch: Fixed): OSErr;
  359.     {$IFC NOT GENERATINGCFM}
  360.     INLINE $203C, $0450, $000C, $A800;
  361.     {$ENDC}
  362. FUNCTION SetSpeechInfo(chan: SpeechChannel; selector: OSType; speechInfo: UNIV Ptr): OSErr;
  363.     {$IFC NOT GENERATINGCFM}
  364.     INLINE $203C, $0654, $000C, $A800;
  365.     {$ENDC}
  366. FUNCTION GetSpeechInfo(chan: SpeechChannel; selector: OSType; speechInfo: UNIV Ptr): OSErr;
  367.     {$IFC NOT GENERATINGCFM}
  368.     INLINE $203C, $0658, $000C, $A800;
  369.     {$ENDC}
  370. FUNCTION TextToPhonemes(chan: SpeechChannel; textBuf: Ptr; textBytes: LONGINT; phonemeBuf: Handle; VAR phonemeBytes: LONGINT): OSErr;
  371.     {$IFC NOT GENERATINGCFM}
  372.     INLINE $203C, $0A5C, $000C, $A800;
  373.     {$ENDC}
  374. FUNCTION UseDictionary(chan: SpeechChannel; dictionary: Handle): OSErr;
  375.     {$IFC NOT GENERATINGCFM}
  376.     INLINE $203C, $0460, $000C, $A800;
  377.     {$ENDC}
  378.  
  379. {$ALIGN RESET}
  380. {$POP}
  381.  
  382. {$SETC UsingIncludes := SpeechIncludes}
  383.  
  384. {$ENDC} {__SPEECH__}
  385.  
  386. {$IFC NOT UsingIncludes}
  387.  END.
  388. {$ENDC}
  389.